<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>WikiPlot Administrators Guide</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
	<table class="tutorial-nav-box">
	<tr>
		<td style="width: 30%">
							<span class="nav-button-disabled">Previous</span>
					</td>
		<td style="text-align: center">
					</td>
		<td style="text-align: right; width: 30%">
							<a href="../WikiPlot/tutorial_DeveloperGuide.pkg.html" class="nav-button">Next</a>
					</td>
	</tr>
	<tr>
		<td style="width: 30%">
					</td>
		<td style="text-align: center">
					</td>
		<td style="text-align: right; width: 30%">
							<span class="detail">PlotClass Developer Guide</span>
					</td>
	</tr>
</table>
	
<div><a name=""></a><div class="ref-title-box">WikiPlot Administrators Guide<h1 class="ref-title">WikiPlot Administrators Guide</h1>
		<h2 class="ref-purpose">A System Administrators Guidelines</h2></div>
	<div class="ref-synopsis"><p>The WikiPlot Development Team.</p>
			<div class="authors"><h2 class="title">Authors</h2><span class="author">Jonas F. Jensen.
				<div class="author-blurb"><a href="mailto:wikiplot@jopsen.dk">WikiPlot@Jopsen.dk</a></div></span>
			<span class="author">Ismail Faizi
				<div class="author-blurb"><a href="mailto:kanafghan@gmail.com">KanAfghan@Gmail.com</a></div></span></div></div>
	<span><a name="AdminGuide"></a><p>This guide is intended for system administrators. It will help you install WikiPlot, and maintain your installation updated, with as little effort as possible. If you are maintainer/administrator of a MediaWiki installation, this is your guide for WikiPlot.</p>
		<span><h3 class="title">Installation</h3><p>WikiPlot can be installed as any other <a href="http://meta.wikimedia.org/wiki/MediaWiki_extensions">MediaWiki extension</a>, first you obtain a copy of WikiPlot, we recommend that you download the latest stable from our <a href="http://wikiplot.googlecode.com/svn/web/index.html">homepage</a>. You can also checkout a(n) (un)stable from SVN, but if you do that you must also rename some directories and stuff, which is not covered here.</p>
			<p>Once you have obtained a stable copy of WikiPlot, extract it and place the WikiPlot directory in the extensions directory of your MediaWiki installation. Now you will have to activate your extension in the LocalSettings.php file of your MediaWiki installation. This is done by adding following line:</p>
			<div class="src-code"><pre>
//Enable the WikiPlot extension
require_once(&quot;extensions/WikiPlot/WikiPlot.php&quot;);
</pre></div>
			<p>Now you have installed the WikiPlot extension, but you are NOT all done yet. WikiPlot requires access to a cache, before it can work. Configuration of WikiPlot and its cache is covered next.</p></span>
		<span><h3 class="title">Settings/Caching</h3><p>Once you have installed WikiPlot, you must configure its cache before you can use WikiPlot. First you must have a place to save cached images, create an empty directory and give php write permissions to the directory (hint: the directory must be accessible from http). Once you have created a directory for the cache, you must tell WikiPlot where this directory is located, you do that by opening WikiPlotSettings.php from extensions/WikiPlot/WikiPlotSettings.php, and redefining the constants defined there. Like this:</p>
			<ul mark = "bullet"><li><p><em>WikiPlotCachePath</em></p>
					<blockquote><p>The path to the cache directory you have just created. This path is relative to DOCUMENT_ROOT, your DOCUMENT_ROOT is usually /public_html/, which means that if your cache directory is in /public_html/catch/ then WikiPlotCachePath should be /cache/. You can find your DOCUMENT_ROOT in your phpinfo() data.</p></blockquote></li>
				<li><p><em>WikiPlotCacheURL</em></p>
					<blockquote><p>The path to the cache directory is the same directory as used in WikiPlotCachePath, but this time your path is relative to http://, which means that if your site is mysite.com and your cache directory is placed in DOCUMENT_ROOT (usually /public_html/) then the URL (WikiPlotCacheURL) to your cache should be http://mysite.com/cache/</p></blockquote></li></ul>
			<p>More specific configuration of your cache can be done in WikiPlotSettings.php, if you have any questions regarding these settings, take a look at the sourcecode documentation or feel free to contact us. More advanced configuration of the cache is not covered here.</p>
			<h4 class="title">Keep the cache clean</h4><p>If your users uses WikiPlot a lot, and changes the plots a lot, WikiPlot will generate an awful lot of unused images in the cache, at some point this might be considered a waste of server resources. Therefore it is recommended that you cleanup the catch on a regular basis. You can cleanup the cache by running /extensions/WikiPlot/CleanupCache.php, you may run this script as a cron job.</p>
				<p>The script removes all images that have not been accessed for a given period. It is also possible to remove all images of a certain age. You can find the settings for this file in WikiPlotSettings.php, advanced configuration of this script is not covered here, see sourcecode documentation for further information.</p><br /></span>
		<span><h3 class="title">Stay updated</h3><p>Once you have installed WikiPlot, you might want to make sure that your installation is kept updated, both for security and performance reasons. And perhaps there will come some new features as well. To stay updated on the WikiPlot releases subscribe to our <a href="http://groups.google.com/group/wikiplot-announcements">announcement list</a>, members of this list will only be contacted regarding new releases, and in case of serious security issues. Subscribe and stay updated.</p></span>
		<span><h3 class="title">Support/Help</h3><p>If you have any questions or problems with WikiPlot, feel free to contact us, you can use our <a href="http://groups.google.com/group/wikiplot">development mailinglist</a>. It is not just a list for WikiPlot development, but a list for everything regarding WikiPlot, help, bug, questions and what ever.</p></span></span></div>

	<table class="tutorial-nav-box">
	<tr>
		<td style="width: 30%">
							<span class="nav-button-disabled">Previous</span>
					</td>
		<td style="text-align: center">
					</td>
		<td style="text-align: right; width: 30%">
							<a href="../WikiPlot/tutorial_DeveloperGuide.pkg.html" class="nav-button">Next</a>
					</td>
	</tr>
	<tr>
		<td style="width: 30%">
					</td>
		<td style="text-align: center">
					</td>
		<td style="text-align: right; width: 30%">
							<span class="detail">PlotClass Developer Guide</span>
					</td>
	</tr>
</table>
	
	<p class="notes" id="credit">
		Documentation generated on Fri, 13 Oct 2006 16:12:22 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0</a>
	</p>
	</div></body>
</html>